package com.huiqiao.lesson9.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * Swagger3 配置类
 * 说明：
 * - Springfox 3.x 对应 OpenAPI 3.0 规范
 * - 主要作用：告诉 Swagger 去扫描哪些 Controller、生成哪些接口文档
 */
@Configuration
public class SwaggerConfig {

    /**
     * 创建 Docket Bean，用于配置 Swagger 的核心信息
     * Docket 是 Swagger 的主要配置入口
     */
    @Bean // 注册到 Spring 容器，让容器能加载此配置
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30) // 指定文档类型为 OAS_30（OpenAPI 3.0 版本）
                .apiInfo(apiInfo())                  // 设置接口文档的基本信息（标题、描述、版本等）
                .select()                            // 开启接口扫描的选择器
                // 指定要扫描的包路径，只会生成该包下 Controller 的接口文档
                .apis(RequestHandlerSelectors.basePackage("com.huiqiao.lesson9.controller"))
                // 指定路径规则，这里选择所有路径（也可按路径过滤）
                .paths(PathSelectors.any())
                .build();                            // 构建 Docket 实例
    }

    /**
     * 构建接口文档的说明信息（显示在 Swagger 页面顶部）
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Java培训课件接口文档")           // 文档标题
                .description("SpringBoot + Swagger3 示例") // 文档描述
                .version("1.0.0")                       // 文档版本号
                .build();                               // 构建 ApiInfo 实例
    }
}
